home *** CD-ROM | disk | FTP | other *** search
/ TPUG - Toronto PET Users Group / TPUG Users Group CD / TPUG Users Group CD.iso / AMIGA / AMICUS / AMICUS25.ADF / Keep1.1 / Keep.DOC < prev    next >
Text File  |  1989-01-26  |  8KB  |  218 lines
  1.  
  2.  
  3.  
  4.  
  5.  
  6.  
  7.  
  8.                                G'day!
  9.  
  10.  
  11.  
  12.  
  13.  
  14.  
  15.  
  16.  
  17.                             And welcome to...
  18.  
  19.  
  20.  
  21.  
  22.  
  23.  
  24.  
  25.  
  26.  
  27.  
  28.  
  29.  
  30.  
  31. c
  32.  
  33.  
  34.  
  35.  
  36.  
  37.                                Keep v1.1
  38.  
  39.  
  40.  
  41.  
  42.  
  43.      Copyright Notice: Keep v1.1 is copyright (c) 1987 by Tim Grantham. It
  44. may not be sold for profit, nor altered in any way, without the
  45. permission of the author. This version may be freely distributed. The author
  46. would appreciate any feedback users have about the program: bugs,
  47. compliments or money. Said author may be reached at:
  48.  
  49.      55 Sorauren Ave.
  50.      Toronto, Ontario
  51.      Canada. M6R 2C9
  52.      
  53.      (416) 535-1721
  54.      
  55.      or on:
  56.      
  57.      PeopleLink: AMTAG
  58.      BIX: dispatcher
  59.      GEnie: t.grantham
  60.      CIS: 71426,1646
  61.      
  62.      
  63.      
  64.      Keep is a utility program for BBS and network junkies
  65. like myself who download messages in one large file and then read them
  66. off-line. Using only the mouse, you can drive through such files a message
  67. at a time, examine each at your leisure and tag those you wish to keep.
  68. When the entire file has been examined, keep goes through the file
  69. once more and stores those messages that have been so tagged. The original
  70. file is left intact.
  71.  
  72.  
  73.      The program is currently runnable only from the CLI. You can invoke it
  74. in a number of ways. The recommended one is as follows:
  75.  
  76.               run keep
  77.               
  78. This program uses Charlie Heath's excellent file requester to pick the file
  79. to be examined. Believe me, it's a lot faster than typing it in.
  80.  
  81. However, you can specify the source file from the CLI thusly:
  82.  
  83.               run keep message_file              
  84.               
  85. This will examine the file message_file and store the messages to be
  86. kept in the file message_file.kpt, in the directory where the 
  87. source file resides.
  88.  
  89. If you wish to cross directories, you can enter, for example
  90.  
  91.               run keep df1:message_file to df0:file_name              
  92.               
  93. The .kpt extension will be automatically appended to the
  94. destination file name. However, you must specify a destination file
  95. name! Simply entering, for example,
  96.  
  97.               run keep df1:message_file to df0:              
  98.               
  99. will not work.
  100.  
  101.  
  102.      Keep opens its own screen to the same size as the Workbench
  103. screen (640 x 200 or larger). This is handy if you are using morerows
  104. or interlace to get a larger display area.
  105.  
  106.      Keep assumes that message files consist of lines of no more
  107. than 120 characters, ending with CR and/or LF. Any non-text character
  108. contained in the line before the CR/LF will be displayed -- usually as a
  109. rectangle; the CR/LF do not appear. They are, however, left intact.
  110.  
  111.      Once running, keep is (or should be) self-explanatory. A 
  112. possible source of ambiguity is the gadgets at the top of the window.
  113. Selection of the arrows pointing up and down permit the user to page through
  114. the text of the message. The KEEP and DUMP
  115. gadgets tag the message and advance to the next message. You can 
  116. select the left-pointing arrow to back up to the previous message. Here you
  117. can change the fate of the message by selecting the appropriate KEEP
  118. or DUMP gadget. However, you must return to the current
  119. message by selecting the right-pointing arrow before you can move on to the
  120. next message in the file.
  121.  
  122.      
  123.      You can at any time change the name of the destination file by selecting
  124. To... under the Project menu. However, this version of
  125. keep will not check to see if the output file already exists, nor will it let
  126. you append tagged messages to an existing file.
  127.  
  128.      Skip terminates examination of the current file and saves what
  129. messages had been tagged up to that point.
  130.  
  131.      Abort terminates examination of the current file completely and
  132. restarts the program.
  133.  
  134.      About provides some speculation as to the inspiration of the Guru's
  135. meditations...
  136.  
  137.      And Quit exits the program.
  138.      
  139.      
  140.      Keep does not have to be used exclusively for information
  141. services. It can work with any text database that uses a repeating header at 
  142. the beginning of each record and fields of no more than 120 characters
  143. delimited with CR and/or LF. It looks for a key string of five
  144. characters or less -- the shorter the string, the faster the search. You can
  145. see which ones I have chosen: each time a network gadget is selected in the
  146. service requester, the Key string string gadget is updated. You can
  147. click on this gadget to customize the key string.
  148.      
  149.      
  150.      If the program encounters a read error in the message file, it will save
  151. those  messages currently tagged and offer to restart the program -- in
  152. other words, it will behave as if you had selected the Skip
  153. option.
  154.      
  155.      If the program encounters an error during the writing of the destination
  156. file, it will close that file and save to ram: instead -- very handy if you
  157. just spent four hours going through 700+ messages. In this case, however, the
  158. default destination file name will be used.
  159.  
  160.  
  161. Enhancements to future versions of Keep may include:
  162.      
  163.      1. Much more attractive, Image-rendered gadgets.
  164.      
  165.      2. Workbench support.
  166.  
  167.      3. Command line and menu support for interlace.
  168.      
  169.      4. More polished mutual exclude in the service requester.
  170.      
  171.      5. Support for other fonts.
  172.      
  173.      6. Depth arrangement gadgets. The screen can be pulled down
  174.         in this version -- two pixels of the screen behind are there to grab.
  175.         
  176.      7. Support for other BBSs and networks.
  177.         
  178.      8. Support for arbitrarily large files and messages. In this
  179.         version, Keep is confined to files containing up to 2000
  180.         messages or records. In addition, it reads in no more than 1000 lines
  181.         at a time. This latter aspect does not compromise the operation of
  182.         the program should the message be larger than 1000 lines. It simply
  183.         splits it into smaller pieces. If you want to save a complete
  184.         message, save all the pieces.
  185.  
  186.      9. More elegant command line parsing.
  187.  
  188.      10. The ability to use the mouse to mark portions of 
  189.          messages for keeping.
  190.      
  191.      11. Word wrap for lines longer than 80 characters.
  192.      
  193.      12. Scrolling, rather than paging of text.
  194.      
  195.      13. A proportional gadget to indicate the current position in
  196.          the source file.
  197.         
  198.         
  199.      The shareware program blitzfonts works with Keep and is highly
  200. recommended.
  201.  
  202.  
  203.      I would like to thank Charlie Heath, William Volk, and Chris Zamara for
  204. their help. I especially would like to thank the real Nick Sullivan, for his
  205. endlessly patient assistance. Keep is a direct descendant, 
  206. several generations removed, of a program Nick wrote in CBM Basic and
  207. 6502 ML for the C64 and PET 8032.
  208.  
  209.      
  210.      My greatest debt is to my wife Cate and my son Alex, for their love.
  211.      
  212.      
  213. Subscribe to The Transactor for the Amiga, for the best in Amiga coverage,
  214. including Amiga Dispatches by yours truly. The Transactor also
  215. operates the Commodore forums CBMPRG and CBMCOM on Compuserve.
  216.      
  217.      
  218.